All files / core target_id_generator.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2x
 
2x
2x
2x
 
 
 
 
 
 
 
 
 
2x
 
 
3008x
 
2246x
2246x
2246x
 
 
 
 
 
 
 
1482x
 
 
 
 
 
 
 
 
764x
 
 
 
 
2x
658x
658x
 
 
2301x
1479x
 
 
2x
760x
 
2x
 
/**
 * Copyright 2017 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
import { TargetId } from './types';
 
const RESERVED_BITS = 1;
 
enum GeneratorIds {
  LocalStore = 0,
  SyncEngine = 1
}
 
/**
 * TargetIdGenerator generates monotonically increasing integer IDs. There are
 * separate generators for different scopes. While these generators will operate
 * independently of each other, they are scoped, such that no two generators
 * will ever produce the same ID. This is useful, because sometimes the backend
 * may group IDs from separate parts of the client into the same ID space.
 */
export class TargetIdGenerator {
  private previousId: TargetId;
 
  constructor(private generatorId: number, initAfter: TargetId = 0) {
    // Replace the generator part of initAfter with this generator's ID.
    const afterWithoutGenerator = (initAfter >> RESERVED_BITS) << RESERVED_BITS;
    const afterGenerator = initAfter - afterWithoutGenerator;
    if (afterGenerator >= generatorId) {
      // For example, if:
      //   this.generatorId = 0b0000
      //   after = 0b1011
      //   afterGenerator = 0b0001
      // Then:
      //   previous = 0b1010
      //   next = 0b1100
      this.previousId = afterWithoutGenerator | this.generatorId;
    } else {
      // For example, if:
      //   this.generatorId = 0b0001
      //   after = 0b1010
      //   afterGenerator = 0b0000
      // Then:
      //   previous = 0b1001
      //   next = 0b1011
      this.previousId =
        (afterWithoutGenerator | this.generatorId) - (1 << RESERVED_BITS);
    }
  }
 
  next(): TargetId {
    this.previousId += 1 << RESERVED_BITS;
    return this.previousId;
  }
 
  static forLocalStore(initAfter: TargetId = 0): TargetIdGenerator {
    return new TargetIdGenerator(GeneratorIds.LocalStore, initAfter);
  }
 
  static forSyncEngine(): TargetIdGenerator {
    return new TargetIdGenerator(GeneratorIds.SyncEngine);
  }
}